feat: features OTCR natively in canary #3061

kokekanon · 2024-11-04T23:28:34Z

6/6

for test use this client.exe https://github.com/mehah/otclient/actions/runs/11730256085
or use this in terminal

ProtocolGame.registerOpcode(0x43, function(protocol, msg)
    local count = msg:getU16()
    for i = 1, count do
      local feature = msg:getU8()
	  local enable = msg:getU8()
	  if enable == 1 then
		g_game.enableFeature(feature)
	  end
	end
end)

Description

Feature	Done	No break v8 or cipsoft
1.- Creature AE + Shader	✅	✅
2.- send disableFeature / enableFeature . easy to modify in config.lua	✅ mehah/otclient#962	✅
3.- outfit (wings,aura,shader)	✅	✅
4.- TypingIcon	✅	✅
5.- map shader support	✅	✅
6- item Shader	✅	✅

1.-Creature AE + Shader

no break cipsoft or v8

2.-send disableFeature / enableFeature . easy to modify in config.lua

it is easier for the server administrator to modify config.lua than to compile every time he wants to add or remove a feature.
note1: v8 and otcr send the same packets, so it could be only 1 function, but i don't want to break anything.

note2 : In otcr requires modification in the client * is not yet ready

3.- outfit (wings,aura,shader)

4.- TypingIcon

5.- map shader support

6.- item Shader

Type of change

New feature (non-breaking change which adds functionality)

How Has This Been Tested

1/6 Creature : AttachedEffect | Shader

Client:
--   g_game.enableFeature(GameCreatureAttachedEffect)
--   g_game.enableFeature(GameCreatureShader)
Server:
	player:setShader("Outfit - Rainbow")
	player:attachEffectById(7)
	player:attachEffectById(8)

2/6 Player: Map Shader

	player:setMapShader("Map - Party")

4/6 feature: Item Shader

--Client:
	g_game.enableFeature(GameItemShader)
-- Server:
	player:addItem(ITEM_BAG, 1, false, CONST_SLOT_BACKPACK):setShader("Map - Party")

5/6 send disableFeature / enableFeature. easy to modify in config.lua

const auto &enabledFeatures = g_configManager().getEnabledOTCFeatures();
const auto &disabledFeatures = g_configManager().getDisabledOTCFeatures();

for (auto feature : enabledFeatures) {
g_logger().info("Feature enabled: {}", feature);
}

for (auto feature : disabledFeatures) {
g_logger().info("Feature disabled: {}", feature);
}

6/6

x:addCustomOutfit("aura", 8)
x:removeCustomOutfit("aura", 8)

Test Configuration:

Server Version: 13.40
Client: OTCR
Operating System: 11

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I checked the PR checks reports
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works

Note: To be honest, I'm not good at C++, and I don't use Canary, I'm not used to the structure.

attachEffectById detachEffectById getShader setShader

player:setMapShader("Map - Party")

src/game/game.cpp

dudantas

Thank you for your contribution. I have a few observations that could help further improve the work.

src/creatures/creature.cpp

src/creatures/creature.hpp

src/creatures/players/player.cpp

src/game/game.cpp

src/items/item.hpp

const auto &enabledFeatures = g_configManager().getEnabledOTCFeatures(); const auto &disabledFeatures = g_configManager().getDisabledOTCFeatures(); for (int32_t feature : enabledFeatures) { g_logger().info("Feature enabled: {}", feature); } for (int32_t feature : disabledFeatures) { g_logger().info("Feature disabled: {}", feature); } Update configmanager.hpp

dudantas · 2024-11-05T05:50:24Z

src/creatures/creature.hpp

@@ -695,7 +695,7 @@ class Creature : virtual public Thing, public SharedObject {
 	std::string getShader() const {
 		return shader;
 	}
-	void setShader(const std::string &shaderName) {
+	void setShader(const std::string_view &shaderName) {


You can remove the & as well; passing a std::string_view by reference actually increases overhead. std::string_view is intended to be passed by value since it is simply a lightweight view of the string.

dudantas · 2024-11-05T05:51:49Z

src/creatures/players/player.hpp

@@ -1383,7 +1383,7 @@ class Player final : public Creature, public Cylinder, public Bankable {
 	std::string name;
 	std::string guildNick;
 	std::string loyaltyTitle;
-	std::string mapShader;
+	std::string_view mapShader;


Here, it will remain as std::string. std::string_view is used to avoid copying the string, but in the final context where it needs to be stored or modified, it must be a std::string.

dudantas · 2024-11-05T05:53:43Z

Apologies for the confusion. In the setShader method, you can continue using std::string_view, but for all other methods, they can remain as std::string.

PS: If you need, I can help commit.

dudantas · 2024-11-05T06:15:23Z

@kokekanon
I couldn't commit directly to your fork, but here's the commit if you want to cherry pick it
1437b7e

…re-redemption

…/kokekanon/canary3 into kokekanon/all-feature-redemption

reload required ? iOLoginData load, save? need clean Player.cpp

kokekanon · 2024-11-07T18:43:06Z

src/server/network/protocol/protocolgame.cpp

@@ -1719,7 +1719,7 @@ void ProtocolGame::parseSetOutfit(NetworkMessage &msg) {
 				g_logger().debug("Bool isMounted: {}", isMounted);
 			}

-			uint8_t isMountRandomized = msg.getByte();
+			uint8_t isMountRandomized = !oldProtocol ? msg.getByte() : 0;


v8 old protocol no send "isMountRandomized" , last packet is newOutfit.lookMount = msg.get<uint16_t>(); canary read in (L1711)

https://github.com/opentibiabr/otcv8/blob/main/src/client/protocolgamesend.cpp#L833

Redemption 11.00 no send isMountRandomized only in 13.40

kokekanon · 2024-11-07T18:48:43Z

src/server/network/protocol/protocolgame.cpp

-		msg.addByte(newOutfit.lookMountBody);
-		msg.addByte(newOutfit.lookMountLegs);
-		msg.addByte(newOutfit.lookMountFeet);
-	}
 	writeToOutputBuffer(msg);


load this (sendCreatureOutfit and AddCreature) into AddOutfit
(same packets)

kokekanon · 2024-11-07T18:50:20Z

src/server/network/protocol/protocolgame.cpp

-			msg.addByte(outfit.lookMountBody);
-			msg.addByte(outfit.lookMountLegs);
-			msg.addByte(outfit.lookMountFeet);
-		}
 	} else {


load this (sendCreatureOutfit and AddCreature) into AddOutfit
(same packets)

…re-redemption

…/kokekanon/canary3 into kokekanon/all-feature-redemption

…re-redemption

…/kokekanon/canary3 into kokekanon/all-feature-redemption

…re-redemption

sonarqubecloud · 2024-12-27T23:38:18Z

Quality Gate passed

Issues
14 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
5.2% Duplication on New Code

See analysis details on SonarQube Cloud

kokekanon added 3 commits November 4, 2024 20:11

1/6 feature: Creature : AttachedEffect, Shader

4c54d85

attachEffectById detachEffectById getShader setShader

2/7 feature: Map Shader

745b7b8

player:setMapShader("Map - Party")

3/7 feature: TypingIcon

ee26730

mehah reviewed Nov 5, 2024

View reviewed changes

src/game/game.cpp Outdated Show resolved Hide resolved

mehah reviewed Nov 5, 2024

View reviewed changes

src/game/game.cpp Outdated Show resolved Hide resolved

src/game/game.cpp Outdated Show resolved Hide resolved

src/game/game.cpp Outdated Show resolved Hide resolved

kokekanon added 2 commits November 4, 2024 22:46

review: mehah

23e166a

4/7 feature: Item Shader

eae4112

dudantas reviewed Nov 5, 2024

View reviewed changes

kokekanon added 4 commits November 5, 2024 01:52

review: dudantas

b09547e

fix sonarcloud bot

9484492

fix sonarcloud bot 2

f490ce4

dudantas reviewed Nov 5, 2024

View reviewed changes

dudantas and others added 2 commits November 5, 2024 03:10

fix: wrong review

1437b7e

Code format - (Clang-format)

67777a9

kokekanon and others added 12 commits November 5, 2024 04:12

fix: itemShader old protocol otcr

6766389

clean variable

7c45b97

fix return get shader

bd1854c

missing content player:getAttachedEffects

0ff915e

simple test Talkations. delete when finished

f538950

Lua code format - (Stylua)

0217e80

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

4b5fbad

…re-redemption

format

9fe26c5

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

7956f08

…re-redemption

improve: variable name

8d6961d

Merge branch 'kokekanon/all-feature-redemption' of https://github.com…

558b212

…/kokekanon/canary3 into kokekanon/all-feature-redemption

game_outfit functional version, not cleaned or optimized

3744f16

reload required ? iOLoginData load, save? need clean Player.cpp

kokekanon and others added 2 commits November 7, 2024 15:28

this requires review canary team .no break v8 and cipsoft

789354a

Lua code format - (Stylua)

6a23e40

kokekanon commented Nov 7, 2024

View reviewed changes

kokekanon mentioned this pull request Nov 7, 2024

fix: game_outfit custom compatible with canary ( Familiar, outfit/mount in store) mehah/otclient#962

Draft

13 tasks

kokekanon and others added 20 commits November 7, 2024 16:40

fix: review sonarcloud ?

36da43e

Code format - (Clang-format)

8e939e5

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

c551152

…re-redemption

Merge branch 'kokekanon/all-feature-redemption' of https://github.com…

5b5dc84

…/kokekanon/canary3 into kokekanon/all-feature-redemption

simple test

9e763f7

Lua code format - (Stylua)

300f92c

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

3bb868b

…re-redemption

Merge branch 'kokekanon/all-feature-redemption' of https://github.com…

ef754d0

…/kokekanon/canary3 into kokekanon/all-feature-redemption

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

6b27bb9

…re-redemption

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

6097de3

…re-redemption

murge

ec0bd43

fix: compilation windows

e30fd35

Code format - (Clang-format)

29919ed

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

6ed239c

…re-redemption

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

2c46d0a

…re-redemption

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

687d0b2

…re-redemption

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

dce1886

…re-redemption

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

f44bf10

…re-redemption

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

8350458

…re-redemption

Merge remote-tracking branch 'upstream/main' into kokekanon/all-featu…

4d85029

…re-redemption

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: features OTCR natively in canary #3061

feat: features OTCR natively in canary #3061

kokekanon commented Nov 4, 2024 •

edited

Loading

dudantas left a comment

dudantas Nov 5, 2024

dudantas Nov 5, 2024

dudantas commented Nov 5, 2024 •

edited

Loading

dudantas commented Nov 5, 2024

kokekanon Nov 7, 2024 •

edited

Loading

kokekanon Nov 7, 2024

kokekanon Nov 7, 2024

sonarqubecloud bot commented Dec 27, 2024

feat: features OTCR natively in canary #3061

Are you sure you want to change the base?

feat: features OTCR natively in canary #3061

Conversation

kokekanon commented Nov 4, 2024 • edited Loading

6/6

Description

1.-Creature AE + Shader

2.-send disableFeature / enableFeature . easy to modify in config.lua

3.- outfit (wings,aura,shader)

4.- TypingIcon

5.- map shader support

6.- item Shader

Type of change

How Has This Been Tested

Checklist

Note: To be honest, I'm not good at C++, and I don't use Canary, I'm not used to the structure.

dudantas left a comment

Choose a reason for hiding this comment

dudantas Nov 5, 2024

Choose a reason for hiding this comment

dudantas Nov 5, 2024

Choose a reason for hiding this comment

dudantas commented Nov 5, 2024 • edited Loading

dudantas commented Nov 5, 2024

kokekanon Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

kokekanon Nov 7, 2024

Choose a reason for hiding this comment

kokekanon Nov 7, 2024

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 27, 2024

Quality Gate passed

kokekanon commented Nov 4, 2024 •

edited

Loading

dudantas commented Nov 5, 2024 •

edited

Loading

kokekanon Nov 7, 2024 •

edited

Loading